<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
	<title>Velocity UI for Eclipse</title>
	<meta name="Keywords" content="Velocity, Eclipse, Plugin, Java, Editor, IDE, Open, Source">
</head>

<body>
<h1>Velocity UI for Eclipse</h1>

This project leverages the
<a href="http://www.eclipse.org/" target="_blank">Eclipse platform</a>
(v2.x) 	by adding support for the template/scripting engine 
<a href="http://jakarta.apache.org/velocity/" target="_blank">Velocity</a>.
<p></p>
It provides the following plugins:
<dl>
	<dt><b>org.apache.velocity</b></dt>
	<dd>Velocity binaries (currently v1.3.1-final) packaged as an Eclipse plugin</dd>

	<dt><b>com.googlecode.veloeclipse.vaulttec.ui</b></dt>
	<dd>Velocity-aware text editor (associated to files with extensions '*.vsl' or '*.vm')
		with outline view</dd>
</dl>
<img src="Editor.png" width="800" height="600" alt="" border="0">


<h2>Editor Features</h2>
<ul>
<li>Syntax-highlight for Velocity Template Language (VTL)</li>
<li>Outline view with hierarchy of VTL directives and Velocimacro references</li>
<li>Content assist for VTL directives (<a href="ContentAssistDirectives.png">Screenshot</a>)
	and references (<a href="ContentAssistReferences.png">Screenshot</a>) -> auto-activation
	after the character	'#' or '$' or manually via keyboard shortcut Ctrl+Space</li>
<li>Automatic template validation while typing (the first syntax error is show in task
	list and the according line is marked in annotation column)
	-> <a href="SyntaxError.png">Screenshot</a></li>
<li>Annotation hover with definition of references
	(<a href="AnnotationHover.png">Screenshot</a>) and template syntax errors
	(<a href="SyntaxErrorAnnotation.png">Screenshot</a>)</li>
<li>Go to definition of variable or Velocimacro reference under current cursor position
    (via navigate + context menu or keyboard shortcut F3)<br>
	Use Workbench's navigation history to return to previous location
	(keyboard shortcut 'Alt + Arrow Left').</li>
<li>Comment and uncomment blocks (via Ctrl+/ and Ctrl+\)</li>
<li>Preference pages for definition of Velocity counter name and user-defined
	Velocity directives (<a href="PreferencesUserDirectives.png">Screenshot</a>)</li>
<li>Preference pages for color settings of the editor's syntax highlighting
	(<a href="PreferencesSyntaxHighlighting.png">Screenshot</a>)</li>
<li>Preference pages for Velocimacro library
	(<a href="PreferencesVelocimacroLibrary.png">Screenshot</a>)</li>
</ul>


<h2>Installation</h2>

<h3>Via Eclipse Update Manager</h3>

Online updates are available on
<a href="http://veloedit.sourceforge.net/updates/">http://veloedit.sourceforge.net/updates/</a>.
Define a site bookmark in Eclipse's Update Manager view
(<a href="UpdateSiteBookmark.png">Screenshot</a>), navigate to the update site via this
bookmark (<a href="UpdateSitePreview.png">Screenshot</a>) and install the Velocity UI feature.
<p></p>
This update site can also be downloaded from
<a href="http://sourceforge.net/project/showfiles.php?group_id=69218" target="_blank">SourceForge</a>
and used locally.


<h3>Manually</h3>

Download the archives <i>org.apache.velocity_x.x.x.zip</i> and
<i>com.googlecode.veloeclipse.vaulttec.ui_x.x.x.zip</i> from
<a href="http://sourceforge.net/project/showfiles.php?group_id=69218" target="_blank">here</a>
and unzip them in your Eclipse plugin directory "&lt;eclipse install path&gt;/plugins/".


<p></p>
<hr>
<A href="http://sourceforge.net"> <IMG src="http://sourceforge.net/sflogo.php?group_id=69218&amp;type=1" width="88" height="31" border="0" alt="SourceForge Logo"></A>
</body>
</html>
